home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 42 / Amiga Format AFCD42 (Issue 126, Aug 1999).iso / -serious- / programming / mui / mcc_transferanim / developer / autodocs / mcc_transferanim.doc
Text File  |  1999-05-17  |  13KB  |  471 lines
  1. TABLE OF CONTENTS
  2.  
  3. TransferAnim.mcc/TransferAnim.mcc
  4. TransferAnim.mcc/MUIA_TransferAnim_BitMap
  5. TransferAnim.mcc/MUIA_TransferAnim_BoingBall
  6. TransferAnim.mcc/MUIA_TransferAnim_Changes
  7. TransferAnim.mcc/MUIA_TransferAnim_DefObjHeight
  8. TransferAnim.mcc/MUIA_TransferAnim_DefObjWidth
  9. TransferAnim.mcc/MUIA_TransferAnim_Delay
  10. TransferAnim.mcc/MUIA_TransferAnim_Depth
  11. TransferAnim.mcc/MUIA_TransferAnim_DisabledFrame
  12. TransferAnim.mcc/MUIA_TransferAnim_DTObj
  13. TransferAnim.mcc/MUIA_TransferAnim_Error
  14. TransferAnim.mcc/MUIA_TransferAnim_File
  15. TransferAnim.mcc/MUIA_TransferAnim_FPS
  16. TransferAnim.mcc/MUIA_TransferAnim_Frame
  17. TransferAnim.mcc/MUIA_TransferAnim_Frames
  18. TransferAnim.mcc/MUIA_TransferAnim_Height
  19. TransferAnim.mcc/MUIA_TransferAnim_MaxWidth
  20. TransferAnim.mcc/MUIA_TransferAnim_Millis
  21. TransferAnim.mcc/MUIA_TransferAnim_NoAnim
  22. TransferAnim.mcc/MUIA_TransferAnim_NoLoop
  23. TransferAnim.mcc/MUIA_TransferAnim_ObjHeight
  24. TransferAnim.mcc/MUIA_TransferAnim_ObjWidth
  25. TransferAnim.mcc/MUIA_TransferAnim_Precision
  26. TransferAnim.mcc/MUIA_TransferAnim_StartFrame
  27. TransferAnim.mcc/MUIA_TransferAnim_SelectedFrame
  28. TransferAnim.mcc/MUIA_TransferAnim_Width
  29. TransferAnim.mcc/MUIA_TransferAnim_ViewMode
  30. TransferAnim.mcc/MUIM_TransferAnim_NoEvent
  31. TransferAnim.mcc/MUIM_TransferAnim_StarTransferAnim
  32. TransferAnim.mcc/MUIM_TransferAnim_StopAnim
  33.  
  34.  
  35. TransferAnim.mcc/TransferAnim.mcc
  36.  
  37. TransferAnim.mcc is a customclass to display transferanimations (as known from
  38. web-browsers). It supports IBrowse, Voyager and AWeb tooltypes to specify
  39. width, height etc for the animation.
  40. It got support for looping animations, no-loop and delay between loops.
  41. You can specify frames per second, FPS, or how many milliseconds you want
  42. to pass between each frame.
  43. It currently makes use of datatypes to load and remap the images, but support
  44. for pre 3.x is planned.
  45.  
  46. I'm open for suggestions and would love to hear your comments!
  47.  
  48. To contact the author write to:
  49.     
  50.     Linus McCabe
  51.     Rogsholmsv 6
  52.     515 32 Viskafors
  53.  
  54.     Sparkle@hehe.com
  55.     come.to/sparkle
  56.  
  57. TransferAnim.mcc/MUIA_TransferAnim_BitMap
  58.  
  59.     NAME
  60.         MUIA_TransferAnim_BitMap -- [..G], struct BitMap *
  61.  
  62.     FUNCTION
  63.  
  64.         This tag will hold the pointer to the bitmap containing the frames.
  65.  
  66. TransferAnim.mcc/MUIA_TransferAnim_BoingBall
  67.  
  68.     NAME
  69.         MUIA_TransferAnim_BoingBall -- [I..], BOOL
  70.  
  71.     FUNCTION
  72.  
  73.         By setting this attribute to TRUE during creation, you'll get the
  74.         internal boingball animation (which is also used if no animation or
  75.         default animation is specified or loadable).
  76.  
  77. TransferAnim.mcc/MUIA_TransferAnim_Changes
  78.  
  79.     NAME
  80.         MUIA_TransferAnim_Changes -- [I..], BOOL
  81.  
  82.     FUNCTION
  83.  
  84.         When this attribute is set to FALSE, the animation will continue
  85.         to go even if the object is selected (when having an inputmode)
  86.         or disabled.
  87.         If it is set to TRUE, the animation will show the frames specified
  88.         by MUIA_TransferAnim_DisabledFrame and MUIA_TransferAnim_SelectedFrame when dis-
  89.         abled or selected.
  90.  
  91.     SEE ALSO
  92.  
  93.         MUIA_TransferAnim_DisabledFrame, MUIA_TransferAnim_SelectedFrame
  94.  
  95. TransferAnim.mcc/MUIA_TransferAnim_DefObjHeight
  96.  
  97.     NAME
  98.         MUIA_TransferAnim_DefObjHeight -- [I..], long
  99.  
  100.     FUNCTION
  101.  
  102.         Specifies the wished default height of the animationobject when using
  103.         MUIV_TransferAnim_Scale or MUIV_TransferAnim_Repeat.
  104.  
  105.     SEE ALSO
  106.  
  107.         MUIA_TransferAnim_DefObjWidth, MUIA_TransferAnim_ObjHeight, MUIA_TransferAnim_ObjWidth 
  108.  
  109. TransferAnim.mcc/MUIA_TransferAnim_DefObjWidth
  110.  
  111.     NAME
  112.         MUIA_TransferAnim_DefObjWidth -- [I..], long
  113.  
  114.     FUNCTION
  115.  
  116.         Specifies the wished default width of the animationobject when using
  117.         MUIV_TransferAnim_Scale or MUIV_TransferAnim_Repeat.
  118.  
  119.     SEE ALSO
  120.  
  121.         MUIA_TransferAnim_DefObjHeight, MUIA_TransferAnim_ObjHeight, MUIA_TransferAnim_ObjWidth 
  122.  
  123. TransferAnim.mcc/MUIA_TransferAnim_Delay
  124.  
  125.     NAME
  126.         MUIA_TransferAnim_Delay -- [ISG], int
  127.  
  128.     FUNCTION
  129.  
  130.         This attribute specifies the time (in milliseconds) that the anim-
  131.         ation is held before restarting (when it is set to loop). 
  132.         Defaults to no delay.
  133.  
  134. TransferAnim.mcc/MUIA_TransferAnim_Depth
  135.  
  136.     NAME
  137.         MUIA_TransferAnim_Depth -- [..G], long
  138.  
  139.     FUNCTION
  140.     
  141.         Holds the depth of the animation bitmap.
  142.  
  143. TransferAnim.mcc/MUIA_TransferAnim_DisabledFrame
  144.  
  145.     NAME
  146.         MUIA_TransferAnim_DisabledFrame -- [IS.], long
  147.  
  148.     FUNCTION
  149.  
  150.         This attribute specifies which frame to show when the object is set
  151.         to disabled.
  152.         This has no effect unless MUIA_TransferAnim_Changes is set to TRUE (default).
  153.         If MUIA_TransferAnim_Changes is set to FALSE, the animation will continue to
  154.         display as usual, even if disabled.
  155.  
  156. TransferAnim.mcc/MUIA_TransferAnim_DTObj
  157.  
  158.     NAME
  159.         MUIA_TransferAnim_DTObj -- [..G], APTR
  160.  
  161.     FUNCTION
  162.  
  163.         This attribute holds a pointer to the datatype object, if availible.
  164.  
  165. TransferAnim.mcc/MUIA_TransferAnim_Error
  166.  
  167.     NAME
  168.         MUIA_TransferAnim_Error -- [..G], LONG
  169.  
  170.     FUNCTION
  171.  
  172.         This attribute holds a possible error condition, if something went wrong.
  173.         The class will not fail, but might behave differently.
  174.  
  175.         Possible error codes atm are:
  176.  
  177.         ERROR_OBJECT_NOT_FOUND,     the file was not found.
  178.         DTERROR_INVALID_DATA    ,         the file was not an image.
  179.  
  180.         In the first case, the object might show the prefered default animation (if it 
  181.         works ok) otherwise it will try to show the internal boingball animation.
  182.  
  183. TransferAnim.mcc/MUIA_TransferAnim_File
  184.  
  185.     NAME
  186.         MUIA_TransferAnim_File -- [ISG], char *
  187.  
  188.     FUNCTION
  189.  
  190.         This tag holds the filename of the animation you wish to display.
  191.         If you set this attribute after creation, no result will be seen
  192.         until the object go throught a new setup, ie, if it's parent group
  193.         is set to Init & ExitChange.
  194.  
  195.         Display information, like number of frames, framewidth, frameheight
  196.         etc, will be taken from the file's icon.
  197.  
  198.         Recognized tooltypes are:
  199.  
  200.         SIZE            =x,y    -    the framesize is x by y pixels.     (AWeb)
  201.         FRAMEWIDTH    =x        -    framewidth is x pixels                (Voyager)
  202.         WIDTH            =x        -    framewidth is x pixels                (IBrowse)
  203.         HEIGHT        =y        -    frameheight in pixels
  204.         FIRST            =x,y    -    coordinates for the first frame    (AWeb)
  205.         DELTA            =x,y    -    how many pixels to move in x &
  206.                                     y direction between frames            (AWeb)
  207.         
  208.         Tooltypes that are not recognized by browsers (afaik)
  209.     
  210.         FPS            =fps    -    How many frames per second the
  211.                                     animation will be dispalyed by.
  212.         SELECTED        =f        -    What frame to show when the animation
  213.                                     is selected (if it has inputmode)
  214.         DISABLED        =f        -    What frame to show when the animation
  215.                                     object is disabled.
  216.  
  217.         Selected and disabled will only take place if the MUIA_TransferAnim_Changes
  218.         is set to true.
  219.  
  220.     EXAMPLE
  221.  
  222.         TransferAnimObj=TransferAnimObject,
  223.                         MUIA_TransferAnim_File, "data:anims/cat_anim.jpg",
  224.                     End;
  225.  
  226. TransferAnim.mcc/MUIA_TransferAnim_FPS
  227.  
  228.     NAME
  229.         MUIA_TransferAnim_FPS -- [ISG], long
  230.  
  231.     FUNCTION
  232.  
  233.         This attribute specifies how many frames per second of the animation
  234.         will be displayed.
  235.         Defaults to 24.
  236.  
  237. TransferAnim.mcc/MUIA_TransferAnim_Frame
  238.  
  239.     NAME
  240.         MUIA_TransferAnim_Frame -- [ISG], long
  241.  
  242.     FUNCTION
  243.     
  244.         This attribute holds the currently shown frame.
  245.         You can manually set this attribute to control you animation.
  246.         Probably makes most sence for non playing animations.
  247.  
  248. TransferAnim.mcc/MUIA_TransferAnim_Frames
  249.  
  250.     NAME
  251.         MUIA_TransferAnim_Frames -- [ISG], long
  252.  
  253.     FUNCTION
  254.  
  255.         This attribute specifies how many frames the animation holds.
  256.  
  257. TransferAnim.mcc/MUIA_TransferAnim_Height
  258.  
  259.     NAME
  260.         MUIA_TransferAnim_Height -- [I..], long
  261.  
  262.     FUNCTION
  263.  
  264.         Specifies the height of the animation.
  265.  
  266. TransferAnim.mcc/MUIA_TransferAnim_MaxWidth
  267.  
  268.     NAME
  269.         MUIA_TransferAnim_MaxWidth -- [..G], long
  270.  
  271.     FUNCTION
  272.  
  273.         Holds the width of the entire bitmap.
  274.  
  275. TransferAnim.mcc/MUIA_TransferAnim_Millis
  276.  
  277.     NAME
  278.         MUIA_TransferAnim_Millis -- [ISG], long
  279.  
  280.     FUNCTION
  281.  
  282.         Specifies the delay in microseconds between each frame.
  283.  
  284.     SEE ALSO
  285.  
  286.         MUIA_TransferAnim_FPS
  287.  
  288. TransferAnim.mcc/MUIA_TransferAnim_NoAnim
  289.  
  290.     NAME
  291.         MUIA_TransferAnim_NoAnim -- [ISG], bool
  292.  
  293.     FUNCTION
  294.  
  295.         If this attribute is set to TRUE, the animation wont play.
  296.  
  297. TransferAnim.mcc/MUIA_TransferAnim_NoLoop
  298.  
  299.     NAME
  300.         MUIA_TransferAni